Esta sección describe los atributos y uso del servicio de API cs-visual-time-sapi-v2.
- Título de la API: cs-visual-time-sapi-v2
- Versión: v1
- URL Base:
https://cs-visual-time-sapi-{env}-v2.us-e1.cloudhub.io/api/
Reemplaza {env}
con:dev
(Desarrollo)qa
(Aseguramiento de Calidad)prod
(Producción)
🔑 Autenticación
Encabezados Requeridos
Encabezado | Tipo | Descripción |
---|
Authorization | String | Token Bearer en el formato Bearer {{API_KEY}} |
client_id | String | Identificador único para clientes de la API |
- Authorization
- Longitud: 36 - 37 caracteres
- Ejemplo:
Bearer abcdefghijklmnopqrstuvwxyz1234567890
- client_id
- Longitud: 32 - 36 caracteres
- Ejemplo:
123e4567-e89b-12d3-a456-426614174000
📌 Estos encabezados son requeridos en todas las solicitudes.
Parámetros de Consulta
Parámetro | Tipo | Requerido | Descripción |
---|
productId | String | ✅ | ID del Producto |
policyId | String | ✅ | ID de la Póliza |
toIssue | Boolean | ✅ | True = Emitir, False = Liberar |
Cuerpo de Respuesta
Devuelve el estado de la póliza y datos de emisión.
📊 Parámetros Comunes
Parámetro | Tipo | Descripción | Requerido |
---|
client_id | String | Identificador del cliente de la API | ✅ |
Authorization | String | Token Bearer para autenticación | ✅ |
🔐 Esquemas de Seguridad
Aplicación de Client ID
Campo | Tipo | Requerido | Longitud | Regex |
---|
client_id | String | Sí | 32 - 36 | [a-zA-Z0-9] |
client_secret | String | Sí | 32 - 64 | [a-zA-Z0-9] |
OAuth 2.0
Campo | Tipo | Requerido | Longitud | Regex |
---|
Authorization | String | Sí | 36 - 37 | [a-zA-Z0-9-_.] |
⚠️ Códigos de Error
Código | Descripción | Solución Sugerida |
---|
400 | Solicitud Incorrecta | Verificar sintaxis y parámetros de solicitud. |
401 | No Autorizado | Validar credenciales de autenticación. |
404 | No Encontrado | Confirmar la URL del endpoint. |
500 | Error Interno del Servidor | Reintentar o contactar soporte técnico. |
------
📞 Soporte
Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.
Correo electrónico: epalma@fgs.co
- Documentación actualizada por última vez: Septiembre 2025
- Para actualizaciones adicionales, consulta el Portal de Exchange de API
Documentación actualizada en Septiembre 2025 por epalma@fgs.co - Edna Nayibe Palma
© 2025 Fundación Grupo Social - Colmena. Archivo generado para la API cs-visual-time-sapi-v2